Google Git
Sign in
chromium / external / gitster / git-htmldocs / b72f60303287a25c0a0305120b203276faca07fa / . / githooks.html
blob: a488a697884dfd59e2ef192830314f8286aa6ec8 [file] [log] [blame]
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]5<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]6<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]7<title>githooks(5)</title>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]8<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]9/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]24}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]30a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]37
38em {
39 font-style: italic;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]40 color: navy;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]41}
42
43strong {
44 font-weight: bold;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]45 color: #083194;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]46}
47
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]48h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]50 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]55h1, h2, h3 {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]56 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]59 padding-top: 0.5em;
60}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]61h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]67h5 {
68 font-size: 1.0em;
69}
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]70
71div.sectionbody {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]72 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]84ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]87ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]89
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]90.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]94 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]97pre {
98 white-space: pre-wrap;
99}
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]100
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]101#author {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]102 color: #527bbd;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]103 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]104 font-size: 1.1em;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]105}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]106#email {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]107}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]108#revnumber, #revdate, #revremark {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]109}
110
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]111#footer {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]117#footer-text {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]121#footer-badges {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]126#preamble {
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]133 margin-top: 1.0em;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]149 color: #527bbd;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]189}
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]190
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]193 text-align: right;
194}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]195
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]219 border-left: 3px solid #dddddd;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]225}
226
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]229a.image:visited { color: white; }
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]238 font-style: normal;
239 color: navy;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]240}
241dd > *:first-child {
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]242 margin-top: 0.1em;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]252 list-style-type: lower-alpha;
253}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]270
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]271tfoot {
272 font-weight: bold;
273}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]277
278div.hdlist {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]284}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]289 vertical-align: top;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]290 font-style: normal;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]291 padding-right: 0.8em;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]292 color: navy;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]293}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]294td.hdlist2 {
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]295 vertical-align: top;
296}
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]305
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]340}
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]341
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]350#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]351 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]526body.manpage h2 {
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]534 body.manpage div#toc { display: none; }
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]536
537
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]731/*]]>*/
732</script>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]733</head>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]734<body class="manpage">
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]735<div id="header">
736<h1>
737githooks(5) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>githooks -
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]742 Hooks used by Git
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]743</p>
744</div>
745</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]747<div class="sect1">
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]749<div class="sectionbody">
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]750<div class="paragraph"><p>$GIT_DIR/hooks/* (or `git config core.hooksPath`/*)</p></div>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]751</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]752</div>
753<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]754<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]755<div class="sectionbody">
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]756<div class="paragraph"><p>Hooks are programs you can place in a hooks directory to trigger
757actions at certain points in git&#8217;s execution. Hooks that don&#8217;t have
758the executable bit set are ignored.</p></div>
759<div class="paragraph"><p>By default the hooks directory is <code>$GIT_DIR/hooks</code>, but that can be
760changed via the <code>core.hooksPath</code> configuration variable (see
761<a href="git-config.html">git-config(1)</a>).</p></div>
762<div class="paragraph"><p>Before Git invokes a hook, it changes its working directory to either
Junio C Hamano4c60d9a2017-05-04 14:36:22[diff] [blame]763$GIT_DIR in a bare repository or the root of the working tree in a non-bare
764repository. An exception are hooks triggered during a push (<em>pre-receive</em>,
765<em>update</em>, <em>post-receive</em>, <em>post-update</em>, <em>push-to-checkout</em>) which are always
766executed in $GIT_DIR.</p></div>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]767<div class="paragraph"><p>Hooks can get their arguments via the environment, command-line
768arguments, and stdin. See the documentation for each hook below for
769details.</p></div>
770<div class="paragraph"><p><em>git init</em> may copy hooks to the new repository, depending on its
771configuration. See the "TEMPLATE DIRECTORY" section in
772<a href="git-init.html">git-init(1)</a> for details. When the rest of this document refers
773to "default hooks" it&#8217;s talking about the default template shipped
774with Git.</p></div>
775<div class="paragraph"><p>The currently supported hooks are described below.</p></div>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]776</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]777</div>
778<div class="sect1">
Junio C Hamanoc28068f2009-09-08 00:55:23[diff] [blame]779<h2 id="_hooks">HOOKS</h2>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]780<div class="sectionbody">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]781<div class="sect2">
782<h3 id="_applypatch_msg">applypatch-msg</h3>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]783<div class="paragraph"><p>This hook is invoked by <em>git am</em>. It takes a single
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]784parameter, the name of the file that holds the proposed commit
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]785log message. Exiting with a non-zero status causes <em>git am</em> to abort
786before applying the patch.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]787<div class="paragraph"><p>The hook is allowed to edit the message file in place, and can
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]788be used to normalize the message into some project standard
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]789format. It can also be used to refuse the commit after inspecting
790the message file.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]791<div class="paragraph"><p>The default <em>applypatch-msg</em> hook, when enabled, runs the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]792<em>commit-msg</em> hook, if the latter is enabled.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]793</div>
794<div class="sect2">
795<h3 id="_pre_applypatch">pre-applypatch</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]796<div class="paragraph"><p>This hook is invoked by <em>git am</em>. It takes no parameter, and is
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]797invoked after the patch is applied, but before a commit is made.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]798<div class="paragraph"><p>If it exits with non-zero status, then the working tree will not be
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]799committed after applying the patch.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]800<div class="paragraph"><p>It can be used to inspect the current working tree and refuse to
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]801make a commit if it does not pass certain test.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]802<div class="paragraph"><p>The default <em>pre-applypatch</em> hook, when enabled, runs the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]803<em>pre-commit</em> hook, if the latter is enabled.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]804</div>
805<div class="sect2">
806<h3 id="_post_applypatch">post-applypatch</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]807<div class="paragraph"><p>This hook is invoked by <em>git am</em>. It takes no parameter,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]808and is invoked after the patch is applied and a commit is made.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]809<div class="paragraph"><p>This hook is meant primarily for notification, and cannot affect
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]810the outcome of <em>git am</em>.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]811</div>
812<div class="sect2">
813<h3 id="_pre_commit">pre-commit</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]814<div class="paragraph"><p>This hook is invoked by <em>git commit</em>, and can be bypassed
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]815with the <code>--no-verify</code> option. It takes no parameters, and is
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]816invoked before obtaining the proposed commit log message and
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]817making a commit. Exiting with a non-zero status from this script
818causes the <em>git commit</em> command to abort before creating a commit.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]819<div class="paragraph"><p>The default <em>pre-commit</em> hook, when enabled, catches introduction
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]820of lines with trailing whitespaces and aborts the commit when
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]821such a line is found.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]822<div class="paragraph"><p>All the <em>git commit</em> hooks are invoked with the environment
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]823variable <code>GIT_EDITOR=:</code> if the command will not bring up an editor
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]824to modify the commit message.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]825</div>
826<div class="sect2">
827<h3 id="_prepare_commit_msg">prepare-commit-msg</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]828<div class="paragraph"><p>This hook is invoked by <em>git commit</em> right after preparing the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]829default log message, and before the editor is started.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]830<div class="paragraph"><p>It takes one to three parameters. The first is the name of the file
Junio C Hamanobd53dbf2009-01-18 18:26:37[diff] [blame]831that contains the commit log message. The second is the source of the commit
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]832message, and can be: <code>message</code> (if a <code>-m</code> or <code>-F</code> option was
833given); <code>template</code> (if a <code>-t</code> option was given or the
834configuration option <code>commit.template</code> is set); <code>merge</code> (if the
835commit is a merge or a <code>.git/MERGE_MSG</code> file exists); <code>squash</code>
836(if a <code>.git/SQUASH_MSG</code> file exists); or <code>commit</code>, followed by
837a commit SHA-1 (if a <code>-c</code>, <code>-C</code> or <code>--amend</code> option was given).</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]838<div class="paragraph"><p>If the exit status is non-zero, <em>git commit</em> will abort.</p></div>
839<div class="paragraph"><p>The purpose of the hook is to edit the message file in place, and
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]840it is not suppressed by the <code>--no-verify</code> option. A non-zero exit
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]841means a failure of the hook and aborts the commit. It should not
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]842be used as replacement for pre-commit hook.</p></div>
Junio C Hamano4b2a6c12017-08-22 18:32:37[diff] [blame]843<div class="paragraph"><p>The sample <code>prepare-commit-msg</code> hook that comes with Git removes the
844help message found in the commented portion of the commit template.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]845</div>
846<div class="sect2">
847<h3 id="_commit_msg">commit-msg</h3>
Junio C Hamanoef75f372017-09-29 04:22:33[diff] [blame]848<div class="paragraph"><p>This hook is invoked by <em>git commit</em> and <em>git merge</em>, and can be
849bypassed with the <code>--no-verify</code> option. It takes a single parameter,
850the name of the file that holds the proposed commit log message.
851Exiting with a non-zero status causes the command to abort.</p></div>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]852<div class="paragraph"><p>The hook is allowed to edit the message file in place, and can be used
853to normalize the message into some project standard format. It
854can also be used to refuse the commit after inspecting the message
855file.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]856<div class="paragraph"><p>The default <em>commit-msg</em> hook, when enabled, detects duplicate
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]857"Signed-off-by" lines, and aborts the commit if one is found.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]858</div>
859<div class="sect2">
860<h3 id="_post_commit">post-commit</h3>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]861<div class="paragraph"><p>This hook is invoked by <em>git commit</em>. It takes no parameters, and is
862invoked after a commit is made.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]863<div class="paragraph"><p>This hook is meant primarily for notification, and cannot affect
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]864the outcome of <em>git commit</em>.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]865</div>
866<div class="sect2">
867<h3 id="_pre_rebase">pre-rebase</h3>
Junio C Hamano947ab822013-03-19 23:07:29[diff] [blame]868<div class="paragraph"><p>This hook is called by <em>git rebase</em> and can be used to prevent a
869branch from getting rebased. The hook may be called with one or
870two parameters. The first parameter is the upstream from which
871the series was forked. The second parameter is the branch being
872rebased, and is not set when rebasing the current branch.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]873</div>
874<div class="sect2">
875<h3 id="_post_checkout">post-checkout</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]876<div class="paragraph"><p>This hook is invoked when a <em>git checkout</em> is run after having updated the
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]877worktree. The hook is given three parameters: the ref of the previous HEAD,
878the ref of the new HEAD (which may or may not have changed), and a flag
879indicating whether the checkout was a branch checkout (changing branches,
880flag=1) or a file checkout (retrieving a file from the index, flag=0).
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]881This hook cannot affect the outcome of <em>git checkout</em>.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]882<div class="paragraph"><p>It is also run after <em>git clone</em>, unless the --no-checkout (-n) option is
Junio C Hamano36a56722009-03-28 08:55:34[diff] [blame]883used. The first parameter given to the hook is the null-ref, the second the
884ref of the new HEAD and the flag is always 1.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]885<div class="paragraph"><p>This hook can be used to perform repository validity checks, auto-display
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]886differences from the previous HEAD if different, or set working dir metadata
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]887properties.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]888</div>
889<div class="sect2">
890<h3 id="_post_merge">post-merge</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]891<div class="paragraph"><p>This hook is invoked by <em>git merge</em>, which happens when a <em>git pull</em>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]892is done on a local repository. The hook takes a single parameter, a status
893flag specifying whether or not the merge being done was a squash merge.
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]894This hook cannot affect the outcome of <em>git merge</em> and is not executed,
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]895if the merge failed due to conflicts.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]896<div class="paragraph"><p>This hook can be used in conjunction with a corresponding pre-commit hook to
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]897save and restore any form of metadata associated with the working tree
Junio C Hamanofb5ffde2014-11-04 22:38:56[diff] [blame]898(e.g.: permissions/ownership, ACLS, etc). See contrib/hooks/setgitperms.perl
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]899for an example of how to do this.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]900</div>
901<div class="sect2">
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]902<h3 id="_pre_push">pre-push</h3>
903<div class="paragraph"><p>This hook is called by <em>git push</em> and can be used to prevent a push from taking
904place. The hook is called with two parameters which provide the name and
905location of the destination remote, if a named remote is not being used both
906values will be the same.</p></div>
907<div class="paragraph"><p>Information about what is to be pushed is provided on the hook&#8217;s standard
908input with lines of the form:</p></div>
909<div class="literalblock">
910<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]911<pre><code>&lt;local ref&gt; SP &lt;local sha1&gt; SP &lt;remote ref&gt; SP &lt;remote sha1&gt; LF</code></pre>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]912</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]913<div class="paragraph"><p>For instance, if the command <code>git push origin master:foreign</code> were run the
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]914hook would receive a line like the following:</p></div>
915<div class="literalblock">
916<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]917<pre><code>refs/heads/master 67890 refs/heads/foreign 12345</code></pre>
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]918</div></div>
Junio C Hamanoe3f080d2013-04-22 02:27:13[diff] [blame]919<div class="paragraph"><p>although the full, 40-character SHA-1s would be supplied. If the foreign ref
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]920does not yet exist the <code>&lt;remote SHA-1&gt;</code> will be 40 <code>0</code>. If a ref is to be
921deleted, the <code>&lt;local ref&gt;</code> will be supplied as <code>(delete)</code> and the <code>&lt;local
922SHA-1&gt;</code> will be 40 <code>0</code>. If the local commit was specified by something other
923than a name which could be expanded (such as <code>HEAD~</code>, or a SHA-1) it will be
Junio C Hamano36d52292013-01-25 21:32:36[diff] [blame]924supplied as it was originally given.</p></div>
925<div class="paragraph"><p>If this hook exits with a non-zero status, <em>git push</em> will abort without
926pushing anything. Information about why the push is rejected may be sent
927to the user by writing to standard error.</p></div>
928</div>
929<div class="sect2">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]930<h3 id="pre-receive">pre-receive</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]931<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]932which happens when a <em>git push</em> is done on a local repository.
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]933Just before starting to update refs on the remote repository, the
934pre-receive hook is invoked. Its exit status determines the success
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]935or failure of the update.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]936<div class="paragraph"><p>This hook executes once for the receive operation. It takes no
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]937arguments, but for each ref to be updated it receives on standard
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]938input a line of the format:</p></div>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]939<div class="literalblock">
940<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]941<pre><code>&lt;old-value&gt; SP &lt;new-value&gt; SP &lt;ref-name&gt; LF</code></pre>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]942</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]943<div class="paragraph"><p>where <code>&lt;old-value&gt;</code> is the old object name stored in the ref,
944<code>&lt;new-value&gt;</code> is the new object name to be stored in the ref and
945<code>&lt;ref-name&gt;</code> is the full name of the ref.
946When creating a new ref, <code>&lt;old-value&gt;</code> is 40 <code>0</code>.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]947<div class="paragraph"><p>If the hook exits with non-zero status, none of the refs will be
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]948updated. If the hook exits with zero, updating of individual refs can
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]949still be prevented by the <a href="#update"><em>update</em></a> hook.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]950<div class="paragraph"><p>Both standard output and standard error output are forwarded to
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]951<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]952for the user.</p></div>
Junio C Hamanoe48a1132016-08-03 22:40:21[diff] [blame]953<div class="paragraph"><p>The number of push options given on the command line of
954<code>git push --push-option=...</code> can be read from the environment
955variable <code>GIT_PUSH_OPTION_COUNT</code>, and the options themselves are
956found in <code>GIT_PUSH_OPTION_0</code>, <code>GIT_PUSH_OPTION_1</code>,&#8230;
957If it is negotiated to not use the push options phase, the
958environment variables will not be set. If the client selects
959to use push options, but doesn&#8217;t transmit any, the count variable
960will be set to zero, <code>GIT_PUSH_OPTION_COUNT=0</code>.</p></div>
Junio C Hamanoe25cc812017-04-24 06:17:43[diff] [blame]961<div class="paragraph"><p>See the section on "Quarantine Environment" in
962<a href="git-receive-pack.html">git-receive-pack(1)</a> for some caveats.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]963</div>
964<div class="sect2">
965<h3 id="update">update</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]966<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]967which happens when a <em>git push</em> is done on a local repository.
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]968Just before updating the ref on the remote repository, the update hook
969is invoked. Its exit status determines the success or failure of
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]970the ref update.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]971<div class="paragraph"><p>The hook executes once for each ref to be updated, and takes
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]972three parameters:</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]973<div class="ulist"><ul>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]974<li>
975<p>
976the name of the ref being updated,
977</p>
978</li>
979<li>
980<p>
981the old object name stored in the ref,
982</p>
983</li>
984<li>
985<p>
Junio C Hamano826f5c42014-02-07 20:33:30[diff] [blame]986and the new object name to be stored in the ref.
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]987</p>
988</li>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]989</ul></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]990<div class="paragraph"><p>A zero exit from the update hook allows the ref to be updated.
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]991Exiting with a non-zero status prevents <em>git-receive-pack</em>
992from updating that ref.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]993<div class="paragraph"><p>This hook can be used to prevent <em>forced</em> update on certain refs by
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]994making sure that the object name is a commit object that is a
995descendant of the commit object named by the old object name.
Junio C Hamano3f680f32009-11-16 02:10:54[diff] [blame]996That is, to enforce a "fast-forward only" policy.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]997<div class="paragraph"><p>It could also be used to log the old..new status. However, it
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]998does not know the entire set of branches, so it would end up
999firing one e-mail per ref when used naively, though. The
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1000<a href="#post-receive"><em>post-receive</em></a> hook is more suited to that.</p></div>
Junio C Hamano198b1f12016-05-17 22:27:24[diff] [blame]1001<div class="paragraph"><p>In an environment that restricts the users' access only to git
1002commands over the wire, this hook can be used to implement access
1003control without relying on filesystem ownership and group
1004membership. See <a href="git-shell.html">git-shell(1)</a> for how you might use the login
1005shell to restrict the user&#8217;s access to only git commands.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1006<div class="paragraph"><p>Both standard output and standard error output are forwarded to
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1007<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1008for the user.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1009<div class="paragraph"><p>The default <em>update</em> hook, when enabled&#8212;and with
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1010<code>hooks.allowunannotated</code> config option unset or set to false&#8212;prevents
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1011unannotated tags to be pushed.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1012</div>
1013<div class="sect2">
1014<h3 id="post-receive">post-receive</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1015<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1016which happens when a <em>git push</em> is done on a local repository.
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1017It executes on the remote repository once after all the refs have
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1018been updated.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1019<div class="paragraph"><p>This hook executes once for the receive operation. It takes no
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1020arguments, but gets the same information as the
1021<a href="#pre-receive"><em>pre-receive</em></a>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1022hook does on its standard input.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1023<div class="paragraph"><p>This hook does not affect the outcome of <em>git-receive-pack</em>, as it
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1024is called after the real work is done.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1025<div class="paragraph"><p>This supersedes the <a href="#post-update"><em>post-update</em></a> hook in that it gets
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1026both old and new values of all the refs in addition to their
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1027names.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1028<div class="paragraph"><p>Both standard output and standard error output are forwarded to
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1029<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1030for the user.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1031<div class="paragraph"><p>The default <em>post-receive</em> hook is empty, but there is
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1032a sample script <code>post-receive-email</code> provided in the <code>contrib/hooks</code>
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1033directory in Git distribution, which implements sending commit
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1034emails.</p></div>
Junio C Hamanoe48a1132016-08-03 22:40:21[diff] [blame]1035<div class="paragraph"><p>The number of push options given on the command line of
1036<code>git push --push-option=...</code> can be read from the environment
1037variable <code>GIT_PUSH_OPTION_COUNT</code>, and the options themselves are
1038found in <code>GIT_PUSH_OPTION_0</code>, <code>GIT_PUSH_OPTION_1</code>,&#8230;
1039If it is negotiated to not use the push options phase, the
1040environment variables will not be set. If the client selects
1041to use push options, but doesn&#8217;t transmit any, the count variable
1042will be set to zero, <code>GIT_PUSH_OPTION_COUNT=0</code>.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1043</div>
1044<div class="sect2">
1045<h3 id="post-update">post-update</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1046<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1047which happens when a <em>git push</em> is done on a local repository.
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1048It executes on the remote repository once after all the refs have
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1049been updated.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1050<div class="paragraph"><p>It takes a variable number of parameters, each of which is the
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1051name of ref that was actually updated.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1052<div class="paragraph"><p>This hook is meant primarily for notification, and cannot affect
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1053the outcome of <em>git-receive-pack</em>.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1054<div class="paragraph"><p>The <em>post-update</em> hook can tell what are the heads that were pushed,
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1055but it does not know what their original and updated values are,
1056so it is a poor place to do log old..new. The
1057<a href="#post-receive"><em>post-receive</em></a> hook does get both original and
1058updated values of the refs. You might consider it instead if you need
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1059them.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1060<div class="paragraph"><p>When enabled, the default <em>post-update</em> hook runs
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1061<em>git update-server-info</em> to keep the information used by dumb
Junio C Hamano88bf5712017-09-10 08:39:23[diff] [blame]1062transports (e.g., HTTP) up to date. If you are publishing
Junio C Hamano076ffcc2013-02-06 05:13:21[diff] [blame]1063a Git repository that is accessible via HTTP, you should
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1064probably enable this hook.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1065<div class="paragraph"><p>Both standard output and standard error output are forwarded to
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1066<em>git send-pack</em> on the other end, so you can simply <code>echo</code> messages
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1067for the user.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1068</div>
1069<div class="sect2">
Junio C Hamano6bb32e62015-02-17 22:11:26[diff] [blame]1070<h3 id="_push_to_checkout">push-to-checkout</h3>
1071<div class="paragraph"><p>This hook is invoked by <em>git-receive-pack</em> on the remote repository,
1072which happens when a <em>git push</em> is done on a local repository, when
1073the push tries to update the branch that is currently checked out
1074and the <code>receive.denyCurrentBranch</code> configuration variable is set to
1075<code>updateInstead</code>. Such a push by default is refused if the working
1076tree and the index of the remote repository has any difference from
1077the currently checked out commit; when both the working tree and the
1078index match the current commit, they are updated to match the newly
1079pushed tip of the branch. This hook is to be used to override the
1080default behaviour.</p></div>
1081<div class="paragraph"><p>The hook receives the commit with which the tip of the current
1082branch is going to be updated. It can exit with a non-zero status
1083to refuse the push (when it does so, it must not modify the index or
1084the working tree). Or it can make any necessary changes to the
1085working tree and to the index to bring them to the desired state
1086when the tip of the current branch is updated to the new commit, and
1087exit with a zero status.</p></div>
1088<div class="paragraph"><p>For example, the hook can simply run <code>git read-tree -u -m HEAD "$1"</code>
1089in order to emulate <em>git fetch</em> that is run in the reverse direction
1090with <code>git push</code>, as the two-tree form of <code>read-tree -u -m</code> is
1091essentially the same as <code>git checkout</code> that switches branches while
1092keeping the local changes in the working tree that do not interfere
1093with the difference between the branches.</p></div>
1094</div>
1095<div class="sect2">
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1096<h3 id="_pre_auto_gc">pre-auto-gc</h3>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1097<div class="paragraph"><p>This hook is invoked by <em>git gc --auto</em>. It takes no parameter, and
Junio C Hamano1aa40d22010-01-21 17:46:43[diff] [blame]1098exiting with non-zero status from this script causes the <em>git gc --auto</em>
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1099to abort.</p></div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1100</div>
1101<div class="sect2">
1102<h3 id="_post_rewrite">post-rewrite</h3>
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1103<div class="paragraph"><p>This hook is invoked by commands that rewrite commits (<code>git commit
1104--amend</code>, <em>git-rebase</em>; currently <em>git-filter-branch</em> does <em>not</em> call
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1105it!). Its first argument denotes the command it was invoked by:
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1106currently one of <code>amend</code> or <code>rebase</code>. Further command-dependent
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1107arguments may be passed in the future.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1108<div class="paragraph"><p>The hook receives a list of the rewritten commits on stdin, in the
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1109format</p></div>
1110<div class="literalblock">
1111<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:53[diff] [blame]1112<pre><code>&lt;old-sha1&gt; SP &lt;new-sha1&gt; [ SP &lt;extra-info&gt; ] LF</code></pre>
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1113</div></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1114<div class="paragraph"><p>The <em>extra-info</em> is again command-dependent. If it is empty, the
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1115preceding SP is also omitted. Currently, no commands pass any
1116<em>extra-info</em>.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1117<div class="paragraph"><p>The hook always runs after the automatic note copying (see
Junio C Hamano96fdfa12016-03-21 20:52:39[diff] [blame]1118"notes.rewrite.&lt;command&gt;" in <a href="git-config.html">git-config(1)</a>) has happened, and
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1119thus has access to these notes.</p></div>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1120<div class="paragraph"><p>The following command-specific comments apply:</p></div>
1121<div class="dlist"><dl>
1122<dt class="hdlist1">
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1123rebase
1124</dt>
1125<dd>
1126<p>
1127 For the <em>squash</em> and <em>fixup</em> operation, all commits that were
1128 squashed are listed as being rewritten to the squashed commit.
1129 This means that there will be several lines sharing the same
1130 <em>new-sha1</em>.
1131</p>
Junio C Hamano81435632011-01-12 09:08:48[diff] [blame]1132<div class="paragraph"><p>The commits are guaranteed to be listed in the order that they were
Junio C Hamano31667362010-03-25 00:38:53[diff] [blame]1133processed by rebase.</p></div>
1134</dd>
1135</dl></div>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1136</div>
Junio C Hamanod88ba732017-05-30 04:14:20[diff] [blame]1137<div class="sect2">
1138<h3 id="_sendemail_validate">sendemail-validate</h3>
1139<div class="paragraph"><p>This hook is invoked by <em>git send-email</em>. It takes a single parameter,
1140the name of the file that holds the e-mail to be sent. Exiting with a
1141non-zero status causes <em>git send-email</em> to abort before sending any
1142e-mails.</p></div>
1143</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1144</div>
1145</div>
1146<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31[diff] [blame]1147<h2 id="_git">GIT</h2>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1148<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:23[diff] [blame]1149<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1150</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1151</div>
Junio C Hamano9d971152012-12-19 00:43:11[diff] [blame]1152</div>
Junio C Hamano7bd050f2011-09-22 06:32:22[diff] [blame]1153<div id="footnotes"><hr /></div>
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1154<div id="footer">
1155<div id="footer-text">
Junio C Hamanoef75f372017-09-29 04:22:33[diff] [blame]1156Last updated 2017-09-29 13:22:11 JST
Junio C Hamano2fbcd212008-05-14 22:26:07[diff] [blame]1157</div>
1158</div>
1159</body>
1160</html>